POST api/imaging/{authenticationToken}/{loanKey}

This method is used to save one or more document images to a loan.

Request Information

URI Parameters

Name	Description	Type	Additional information
authenticationToken	Current authentication token	string	Required
loanKey	The loan key string identifying the loan where the document image(s) will be saved	string	Required

Body Parameters

This is a list of one or more documents that will be saved to the loan.

Collection of ImageModel

Name	Description	Type	Additional information
TaskId	This is the identifier for the document (task). This field is always required.	integer	None.
TaskName	This is the name of the document. This is not required for saving an image.	string	None.
TaskDescription	This is the description of the document. This is not required for saving an image.	string	None.
CustomerKey	If the imaged document is specific to a customer on a loan, then this represents the key identifying the customer. If the document is not customer specific, this should either be blank or "0-0". This is required only if the document is specific to a customer.	string	None.
Extension	This is the extension of the document image, which is potentially used to determine the content type. If an extension is not provided and there is a content type provided, the system will attempt to assign a default extension to the image. Either the extension or content type is required for saving an image.	string	None.
Name	This can be used in multiple ways. This can be the actual file name that was uploaded or can be a vendor specific description of the document. This field is not required for saving an image.	string	None.
Comment	This is a generic comment for the imaged document. This field is not required for saving an image.	string	None.
ImageData	This is the binary image content that will be imaged.	Object	None.
ContentType	This is the MIME type of the image. If this is not provided, then the system will use the extension to determine this type. Either the extension or content type is required for saving an image.	string	None.
ContentLength	This is the length of the imaged document content. This field is not required for saving an image.	integer	None.
DateCreated	This is the date the document was imaged. This field is not required for saving an image.	date	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "TaskId": 1,
    "TaskName": "sample string 2",
    "TaskDescription": "sample string 3",
    "CustomerKey": "sample string 4",
    "Extension": "sample string 5",
    "Name": "sample string 6",
    "Comment": "sample string 7",
    "ImageData": {},
    "ContentType": "sample string 9",
    "ContentLength": 10,
    "DateCreated": "2025-07-07T05:23:50.5776146-05:00"
  },
  {
    "TaskId": 1,
    "TaskName": "sample string 2",
    "TaskDescription": "sample string 3",
    "CustomerKey": "sample string 4",
    "Extension": "sample string 5",
    "Name": "sample string 6",
    "Comment": "sample string 7",
    "ImageData": {},
    "ContentType": "sample string 9",
    "ContentLength": 10,
    "DateCreated": "2025-07-07T05:23:50.5776146-05:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfImageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicAPI.Models">
  <ImageModel>
    <Comment>sample string 7</Comment>
    <ContentLength>10</ContentLength>
    <ContentType>sample string 9</ContentType>
    <CustomerKey>sample string 4</CustomerKey>
    <DateCreated>2025-07-07T05:23:50.5776146-05:00</DateCreated>
    <Extension>sample string 5</Extension>
    <ImageData />
    <Name>sample string 6</Name>
    <TaskDescription>sample string 3</TaskDescription>
    <TaskId>1</TaskId>
    <TaskName>sample string 2</TaskName>
  </ImageModel>
  <ImageModel>
    <Comment>sample string 7</Comment>
    <ContentLength>10</ContentLength>
    <ContentType>sample string 9</ContentType>
    <CustomerKey>sample string 4</CustomerKey>
    <DateCreated>2025-07-07T05:23:50.5776146-05:00</DateCreated>
    <Extension>sample string 5</Extension>
    <ImageData />
    <Name>sample string 6</Name>
    <TaskDescription>sample string 3</TaskDescription>
    <TaskId>1</TaskId>
    <TaskName>sample string 2</TaskName>
  </ImageModel>
</ArrayOfImageModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

This returns a list of image results which indicates the success or failure of each imaged document.

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.